KFbxGlobalSettings Class Reference

#include <kfbxglobalsettings.h>

Inheritance diagram for KFbxGlobalSettings:

Detailed Description

This class contains functions for accessing global settings.

Definition at line 57 of file kfbxglobalsettings.h.


Camera Settings
static const char *	ePRODUCER_PERSPECTIVE
	Defined camera name: PRODUCER_PERSPECTIVE.
static const char *	ePRODUCER_TOP
	Defined camera name: PRODUCER_TOP.
static const char *	ePRODUCER_FRONT
	Defined camera name: PRODUCER_FRONT.
static const char *	ePRODUCER_BACK
	Defined camera name: PRODUCER_BACK.
static const char *	ePRODUCER_RIGHT
	Defined camera name: PRODUCER_RIGHT.
static const char *	ePRODUCER_LEFT
	Defined camera name: PRODUCER_LEFT.
static const char *	ePRODUCER_BOTTOM
	Defined camera name: PRODUCER_BOTTOM.
bool	SetDefaultCamera (const char *pCameraName)
	Sets the default camera.
KString	GetDefaultCamera () const
	Returns the default camera name.
Properties
KFbxTypedProperty< fbxInteger1 >	UpAxis
KFbxTypedProperty< fbxInteger1 >	UpAxisSign
KFbxTypedProperty< fbxInteger1 >	FrontAxis
KFbxTypedProperty< fbxInteger1 >	FrontAxisSign
KFbxTypedProperty< fbxInteger1 >	CoordAxis
KFbxTypedProperty< fbxInteger1 >	CoordAxisSign
KFbxTypedProperty< fbxInteger1 >	OriginalUpAxis
KFbxTypedProperty< fbxInteger1 >	OriginalUpAxisSign
KFbxTypedProperty< fbxDouble1 >	UnitScaleFactor
KFbxTypedProperty< fbxDouble1 >	OriginalUnitScaleFactor
KFbxTypedProperty< fbxDouble3 >	AmbientColor
KFbxTypedProperty< fbxString >	DefaultCamera
KFbxTypedProperty< fbxEnum >	TimeMode
KFbxTypedProperty< fbxTime >	TimeSpanStart
KFbxTypedProperty< fbxTime >	TimeSpanStop
Axis system
void	SetAxisSystem (const KFbxAxisSystem &pAxisSystem)
	Sets the scene's coordinate system.
KFbxAxisSystem	GetAxisSystem ()
	Returns the scene's current coordinate system.
System Units
void	SetSystemUnit (const KFbxSystemUnit &pOther)
	Sets the unit of measurement used by the system.
KFbxSystemUnit	GetSystemUnit () const
	Returns the unit of measurement used by the system.
void	SetOriginalSystemUnit (const KFbxSystemUnit &pOther)
	Sets the original unit of measurement used by the system.
KFbxSystemUnit	GetOriginalSystemUnit () const
	Returns the original unit of measurement used by the system.
Light Settings
void	SetAmbientColor (KFbxColor pAmbientColor)
	Sets the ambient color.
KFbxColor	GetAmbientColor () const
	Returns the ambient color.
Time Settings
void	SetTimeMode (KTime::ETimeMode pTimeMode)
	Sets the time mode.
KTime::ETimeMode	GetTimeMode () const
	Returns the time mode.
void	SetTimelineDefaultTimeSpan (const KTimeSpan &pTimeSpan)
	Sets the default time span of the time line.
void	GetTimelineDefaultTimeSpan (KTimeSpan &pTimeSpan) const
	Returns the default time span of the time line.
Public Member Functions
void	SetOriginalUpAxis (const KFbxAxisSystem &pAxisSystem)
	Sets the coordinate system's original Up Axis when the scene is created.
int	GetOriginalUpAxis () const
	Returns the coordinate system's original Up Axis.

Member Function Documentation

void SetAxisSystem ( const KFbxAxisSystem & pAxisSystem )

Sets the scene's coordinate system.

Parameters:

pAxisSystem

The coordinate system to set.

KFbxAxisSystem GetAxisSystem ( )

Returns the scene's current coordinate system.

Returns:: The scene's current coordinate system.

void SetOriginalUpAxis ( const KFbxAxisSystem & pAxisSystem )

Sets the coordinate system's original Up Axis when the scene is created.

Parameters:

pAxisSystem

The coordinate system whose Up Axis is copied.

int GetOriginalUpAxis ( ) const

Returns the coordinate system's original Up Axis.

Returns:: The coordinate system's original Up Axis when the scene is created. 0 is X, 1 is Y, 2 is Z axis.

void SetSystemUnit ( const KFbxSystemUnit & pOther )

Sets the unit of measurement used by the system.

Parameters:

pOther

The system unit to set.

KFbxSystemUnit GetSystemUnit ( ) const

Returns the unit of measurement used by the system.

Returns:: The unit of measurement used by the system.

void SetOriginalSystemUnit ( const KFbxSystemUnit & pOther )

Sets the original unit of measurement used by the system.

Parameters:

pOther

The original system unit to set.

KFbxSystemUnit GetOriginalSystemUnit ( ) const

Returns the original unit of measurement used by the system.

Returns:: The original unit of measurement used by the system.

void SetAmbientColor ( KFbxColor pAmbientColor )

Sets the ambient color.

Parameters:

pAmbientColor

The ambient color to set.

Remarks:: The ambient color only uses the RGB channels.

KFbxColor GetAmbientColor ( ) const

Returns the ambient color.

Returns:: The ambient color.

bool SetDefaultCamera ( const char * pCameraName )

Sets the default camera.

Parameters:

pCameraName

Name of the default camera.

Returns:: true if camera name is valid, returns false if the camera does not have a valid name.

Remarks:: A valid camera name can be either one of the defined tokens (PRODUCER_PERSPECTIVE, PRODUCER_TOP, PRODUCER_FRONT, PRODUCER_BACK, PRODUCER_RIGHT, PRODUCER_LEFT and PRODUCER_BOTTOM) or the name of a camera inserted in the node tree under the scene's root node.

KString GetDefaultCamera ( ) const

Returns the default camera name.